home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3c / uuid.z / uuid
Encoding:
Text File  |  1998-10-20  |  6.9 KB  |  133 lines
  1.  
  2.  
  3.  
  4. UUUUUUUUIIIIDDDD((((3333CCCC))))                                                              UUUUUUUUIIIIDDDD((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      uuid_create, uuid_create_nil, uuid_compare, uuid_equal, uuid_is_nil,
  10.      uuid_hash, uuid_from_string, uuid_to_string - Universal Unique Identifier
  11.      functions
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssyyyyssss////ttttyyyyppppeeeessss....hhhh>>>>
  15.      ####iiiinnnncccclllluuuuddddeeee <<<<ssssyyyyssss////uuuuuuuuiiiidddd....hhhh>>>>
  16.  
  17.      vvvvooooiiiidddd uuuuuuuuiiiidddd____ccccrrrreeeeaaaatttteeee ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  18.  
  19.      vvvvooooiiiidddd uuuuuuuuiiiidddd____ccccrrrreeeeaaaatttteeee____nnnniiiillll ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  20.  
  21.      bbbboooooooolllleeeeaaaannnn____tttt uuuuuuuuiiiidddd____iiiissss____nnnniiiillll ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  22.  
  23.      bbbboooooooolllleeeeaaaannnn____tttt uuuuuuuuiiiidddd____eeeeqqqquuuuaaaallll ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd1111,,,, uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd2222,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  24.  
  25.      iiiinnnntttt uuuuuuuuiiiidddd____ccccoooommmmppppaaaarrrreeee ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd1111,,,, uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd2222,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  26.  
  27.      vvvvooooiiiidddd uuuuuuuuiiiidddd____ttttoooo____ssssttttrrrriiiinnnngggg ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd,,,, cccchhhhaaaarrrr ********uuuuuuuuiiiidddd____ssssttttrrrr,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  28.  
  29.      vvvvooooiiiidddd uuuuuuuuiiiidddd____ffffrrrroooommmm____ssssttttrrrriiiinnnngggg ((((cccchhhhaaaarrrr ****uuuuuuuuiiiidddd____ssssttttrrrr,,,, uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  30.  
  31.      uuuusssshhhhoooorrrrtttt____tttt uuuuuuuuiiiidddd____hhhhaaaasssshhhh ((((uuuuuuuuiiiidddd____tttt ****uuuuuuuuiiiidddd,,,, uuuuiiiinnnntttt____tttt ****ssssttttaaaattttuuuussss))));;;;
  32.  
  33. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  34.      Universal Unique Identifiers are bit strings that may be generated
  35.      independently on separate nodes (hosts) such that globally unique strings
  36.      result without requiring the hosts to be in communication with each other
  37.      to ensure uniqueness.  They are a component of DCE that have been
  38.      independently reimplemented in IRIX, but is in accordance with the DCE
  39.      specification.  This implementation is API compatible with the DCE
  40.      implementation.
  41.  
  42.      The _s_t_a_t_u_s parameter in all functions is set to _u_u_i_d__s__o_k if the
  43.      functions succeeds, and does not equal _u_u_i_d__s__o_k if the function fails.
  44.      A description of each function follows.
  45.  
  46.      _u_u_i_d__c_r_e_a_t_e creates a new UUID.
  47.  
  48.      _u_u_i_d__c_r_e_a_t_e__n_i_l creates a specially-defined UUID, the nil UUID.  The nil
  49.      UUID may be used to initialize/clear UUID structures.
  50.  
  51.      _u_u_i_d__c_o_m_p_a_r_e defines an ordering relationship between UUIDs.  It returns
  52.      -1, 0, or 1 as determined by the relative order of the argument UUIDs.
  53.      The nil UUID precedes all others in order.  The return values of -1, 0,
  54.      and 1 are generated respectively as _u_u_i_d_1 precedes, is equal to, or
  55.      follows _u_u_i_d_2.
  56.  
  57.      _u_u_i_d__e_q_u_a_l tests two UUIDs for equality.  It returns _B__T_R_U_E if the UUIDs
  58.      are equal, and _B__F_A_L_S_E if they are not.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. UUUUUUUUIIIIDDDD((((3333CCCC))))                                                              UUUUUUUUIIIIDDDD((((3333CCCC))))
  71.  
  72.  
  73.  
  74.      _u_u_i_d__i_s__n_i_l tests a UUID for equality with the nil UUID.  It returns
  75.      _B__T_R_U_E if the UUID is a nil UUID, and _B__F_A_L_S_E if it is not.
  76.  
  77.      _u_u_i_d__h_a_s_h returns a hash value for a UUID.
  78.  
  79.      _u_u_i_d__f_r_o_m__s_t_r_i_n_g converts a string representation of a UUID into its
  80.      binary form.
  81.  
  82.      _u_u_i_d__t_o__s_t_r_i_n_g converts a binary UUID into its string representation.
  83.      Storage for the string is obtained using _m_a_l_l_o_c(3c), and thus should be
  84.      returned using _f_r_e_e(3c).
  85.  
  86. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  87.      malloc(3c), free(3c)
  88.  
  89. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  90.      Return values are described in the description of each (non-void)
  91.      function.  The _s_t_a_t_u_s parameter serves the purpose usually fulfilled by
  92.      the return value.  See above for a description of _s_t_a_t_u_s.
  93.  
  94. NNNNOOOOTTTTEEEESSSS
  95.      The DCE version and this version of _u_u_i_d__c_o_m_p_a_r_e may return different
  96.      results for the same UUIDs.  The same is true for the values returned by
  97.      each version of _u_u_i_d__h_a_s_h.
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.